

<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
  <meta charset="utf-8">
  
  <meta name="viewport" content="width=device-width, initial-scale=1.0">
  
  <title>describe package &mdash; describe 0.1.0 documentation</title>
  

  
  
  
  

  

  
  
    

  

  <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
  <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
  <link rel="stylesheet" href="../_static/css/style.css" type="text/css" />
    <link rel="author" title="About these documents" href="../about.html" />
    <link rel="index" title="Index" href="../genindex.html" />
    <link rel="search" title="Search" href="../search.html" />
    <link rel="next" title="describe.core package" href="describe.core.html" />
    <link rel="prev" title="describe" href="modules.html" /> 

  
  <script src="../_static/js/modernizr.min.js"></script>

</head>

<body class="wy-body-for-nav">

   
  <div class="wy-grid-for-nav">

    
    <nav data-toggle="wy-nav-shift" class="wy-nav-side">
      <div class="wy-side-scroll">
        <div class="wy-side-nav-search">
          

          
            <a href="../index.html" class="icon icon-home"> describe
          

          
          </a>

          
            
            
              <div class="version">
                0.1.0
              </div>
            
          

          
<div role="search">
  <form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
    <input type="text" name="q" placeholder="Search docs" />
    <input type="hidden" name="check_keywords" value="yes" />
    <input type="hidden" name="area" value="default" />
  </form>
</div>

          
        </div>

        <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
          
            
            
              
            
            
              <ul class="current">
<li class="toctree-l1"><a class="reference internal" href="../install.html">Installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="../tutorials/tutorials.html">Tutorials</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="modules.html">Documentation</a><ul class="current">
<li class="toctree-l2 current"><a class="current reference internal" href="#">describe package</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#subpackages">Subpackages</a><ul>
<li class="toctree-l4"><a class="reference internal" href="describe.core.html">describe.core package</a></li>
<li class="toctree-l4"><a class="reference internal" href="describe.data.html">describe.data package</a></li>
<li class="toctree-l4"><a class="reference internal" href="describe.descriptors.html">describe.descriptors package</a></li>
<li class="toctree-l4"><a class="reference internal" href="describe.utils.html">describe.utils package</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#module-describe">Module contents</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../about.html">About</a></li>
</ul>

            
          
        </div>
      </div>
    </nav>

    <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">

      
      <nav class="wy-nav-top" aria-label="top navigation">
        
          <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
          <a href="../index.html">describe</a>
        
      </nav>


      <div class="wy-nav-content">
        
        <div class="rst-content">
        
          















<div role="navigation" aria-label="breadcrumbs navigation">

  <ul class="wy-breadcrumbs">
    
      <li><a href="../index.html">Docs</a> &raquo;</li>
        
          <li><a href="modules.html">describe</a> &raquo;</li>
        
      <li>describe package</li>
    
    
      <li class="wy-breadcrumbs-aside">
        
            
            <a href="../_sources/doc/describe.rst.txt" rel="nofollow"> View page source</a>
          
        
      </li>
    
  </ul>

  
  <hr/>
</div>
          <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
           <div itemprop="articleBody">
            
  <div class="section" id="describe-package">
<h1>describe package<a class="headerlink" href="#describe-package" title="Permalink to this headline">¶</a></h1>
<div class="section" id="subpackages">
<h2>Subpackages<a class="headerlink" href="#subpackages" title="Permalink to this headline">¶</a></h2>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="describe.core.html">describe.core package</a><ul>
<li class="toctree-l2"><a class="reference internal" href="describe.core.html#submodules">Submodules</a></li>
<li class="toctree-l2"><a class="reference internal" href="describe.core.html#module-describe.core.lattice">describe.core.lattice module</a></li>
<li class="toctree-l2"><a class="reference internal" href="describe.core.html#module-describe.core.system">describe.core.system module</a></li>
<li class="toctree-l2"><a class="reference internal" href="describe.core.html#module-describe.core">Module contents</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="describe.data.html">describe.data package</a><ul>
<li class="toctree-l2"><a class="reference internal" href="describe.data.html#submodules">Submodules</a></li>
<li class="toctree-l2"><a class="reference internal" href="describe.data.html#module-describe.data.element_data">describe.data.element_data module</a></li>
<li class="toctree-l2"><a class="reference internal" href="describe.data.html#module-describe.data">Module contents</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="describe.descriptors.html">describe.descriptors package</a><ul>
<li class="toctree-l2"><a class="reference internal" href="describe.descriptors.html#submodules">Submodules</a></li>
<li class="toctree-l2"><a class="reference internal" href="describe.descriptors.html#module-describe.descriptors.acsf">describe.descriptors.acsf module</a></li>
<li class="toctree-l2"><a class="reference internal" href="describe.descriptors.html#module-describe.descriptors.coulombmatrix">describe.descriptors.coulombmatrix module</a></li>
<li class="toctree-l2"><a class="reference internal" href="describe.descriptors.html#module-describe.descriptors.descriptor">describe.descriptors.descriptor module</a></li>
<li class="toctree-l2"><a class="reference internal" href="describe.descriptors.html#module-describe.descriptors.elementaldistribution">describe.descriptors.elementaldistribution module</a></li>
<li class="toctree-l2"><a class="reference internal" href="describe.descriptors.html#module-describe.descriptors.ewaldmatrix">describe.descriptors.ewaldmatrix module</a></li>
<li class="toctree-l2"><a class="reference internal" href="describe.descriptors.html#module-describe.descriptors.lmbtr">describe.descriptors.lmbtr module</a></li>
<li class="toctree-l2"><a class="reference internal" href="describe.descriptors.html#module-describe.descriptors.matrixdescriptor">describe.descriptors.matrixdescriptor module</a></li>
<li class="toctree-l2"><a class="reference internal" href="describe.descriptors.html#module-describe.descriptors.mbtr">describe.descriptors.mbtr module</a></li>
<li class="toctree-l2"><a class="reference internal" href="describe.descriptors.html#module-describe.descriptors.sinematrix">describe.descriptors.sinematrix module</a></li>
<li class="toctree-l2"><a class="reference internal" href="describe.descriptors.html#module-describe.descriptors.soap">describe.descriptors.soap module</a></li>
<li class="toctree-l2"><a class="reference internal" href="describe.descriptors.html#module-describe.descriptors">Module contents</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="describe.utils.html">describe.utils package</a><ul>
<li class="toctree-l2"><a class="reference internal" href="describe.utils.html#submodules">Submodules</a></li>
<li class="toctree-l2"><a class="reference internal" href="describe.utils.html#module-describe.utils.stats">describe.utils.stats module</a></li>
<li class="toctree-l2"><a class="reference internal" href="describe.utils.html#module-describe.utils">Module contents</a></li>
</ul>
</li>
</ul>
</div>
</div>
<div class="section" id="module-describe">
<span id="module-contents"></span><h2>Module contents<a class="headerlink" href="#module-describe" title="Permalink to this headline">¶</a></h2>
</div>
</div>


           </div>
           
          </div>
          <footer>
  
    <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
      
        <a href="describe.core.html" class="btn btn-neutral float-right" title="describe.core package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
      
      
        <a href="modules.html" class="btn btn-neutral" title="describe" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
      
    </div>
  

  <hr/>

  <div role="contentinfo">
    <p>
        &copy; Copyright .

    </p>
  </div>
  Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. 

</footer>

        </div>
      </div>

    </section>

  </div>
  


  

    <script type="text/javascript">
        var DOCUMENTATION_OPTIONS = {
            URL_ROOT:'../',
            VERSION:'0.1.0',
            LANGUAGE:'None',
            COLLAPSE_INDEX:false,
            FILE_SUFFIX:'.html',
            HAS_SOURCE:  true,
            SOURCELINK_SUFFIX: '.txt'
        };
    </script>
      <script type="text/javascript" src="../_static/jquery.js"></script>
      <script type="text/javascript" src="../_static/underscore.js"></script>
      <script type="text/javascript" src="../_static/doctools.js"></script>
      <script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.1/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>

  

  <script type="text/javascript" src="../_static/js/theme.js"></script>

  <script type="text/javascript">
      jQuery(function () {
          SphinxRtdTheme.Navigation.enable(true);
      });
  </script> 

</body>
</html>